/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.extensions.sse.metamodel.facets;

import org.apache.causeway.applib.value.LocalResourcePath;
import org.apache.causeway.core.metamodel.facets.SingleClassValueFacet;
import org.apache.causeway.extensions.sse.applib.annotations.SseSource;

/**
 * Corresponds to <tt>@???(observe=...)</tt> annotation in the Causeway programming model.
 */
public interface SseObserveFacet extends SingleClassValueFacet {

    Class<? extends SseSource> getEventStreamType();

    default LocalResourcePath getEventStreamResource() {
        final String eventStreamId = getEventStreamType().getName();
        final LocalResourcePath ssePath = new LocalResourcePath("/sse?eventStream=" + eventStreamId);
        return ssePath;
    }

}
